/**
 * Copyright 2010 Tristan Slominski
 *
 * Licensed under the MIT License (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.opensource.org/licenses/mit-license.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.mindash.handlebars.client.services;

import com.google.gwt.event.logical.shared.ValueChangeHandler;
import com.google.gwt.user.client.History;
import com.mindash.handlebars.client.events.handlers.ReloadEventHandler;
import com.mindash.handlebars.client.places.AtPlace;
import com.mindash.handlebars.client.places.GoToPlace;
import com.mindash.handlebars.client.places.handlers.GoToPlaceGenericHandler;

/**
 * @author Tristan Slominski
 * 
 */
public interface PlaceService extends GoToPlaceGenericHandler,
    ReloadEventHandler, ValueChangeHandler<String> {

  /**
   * Compares the provided {@code atPlace} with the one the application is
   * currently at.
   * 
   * @param atPlace the atPlace to compare
   * @return {@code true} if equal, {@code false} otherwise
   */
  public boolean atPlaceEquals(AtPlace<?> atPlace);

  /**
   * Initializes the place service by registering with History. Registers all
   * event handlers for {@link GoToPlace}'s on {@link EventBus}. Fires the first
   * event ({@link History#fireCurrentHistoryState()}).
   */
  public void initialize();

}
